<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Serial: serial::Serial Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Serial
   &#160;<span id="projectnumber">V.1.0.0</span>
   </div>
   <div id="projectbrief">Cross-Platform, Serial Port Library built on Boost.Asio in Modern C++ 17</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceserial.html">serial</a></li><li class="navelem"><a class="el" href="classserial_1_1_serial.html">Serial</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classserial_1_1_serial-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">serial::Serial Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_serial_8h_source.html">Serial.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a99b2dca0960526547c5a4a573237c615"><td class="memItemLeft" align="right" valign="top">typedef boost::asio::serial_port_base::flow_control::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a99b2dca0960526547c5a4a573237c615">flowControlType</a></td></tr>
<tr class="separator:a99b2dca0960526547c5a4a573237c615"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ab9d6bc487d9f07907917d3b5e7c90f"><td class="memItemLeft" align="right" valign="top">typedef boost::asio::serial_port_base::parity::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a4ab9d6bc487d9f07907917d3b5e7c90f">parityType</a></td></tr>
<tr class="separator:a4ab9d6bc487d9f07907917d3b5e7c90f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae41b45f62e5e46f53f650f2a2678b407"><td class="memItemLeft" align="right" valign="top">typedef boost::asio::serial_port_base::stop_bits::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#ae41b45f62e5e46f53f650f2a2678b407">stopBitsType</a></td></tr>
<tr class="separator:ae41b45f62e5e46f53f650f2a2678b407"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7d30495c321c8ebc8d81278b2df2706"><td class="memItemLeft" align="right" valign="top">typedef boost::system::errc::errc_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#af7d30495c321c8ebc8d81278b2df2706">errorCode</a></td></tr>
<tr class="separator:af7d30495c321c8ebc8d81278b2df2706"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab4d8c523610ac8640b52a69b5287b93c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#ab4d8c523610ac8640b52a69b5287b93c">Serial</a> ()</td></tr>
<tr class="separator:ab4d8c523610ac8640b52a69b5287b93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a071000a2f5f77a40df8311fad5044481"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a071000a2f5f77a40df8311fad5044481">~Serial</a> ()</td></tr>
<tr class="separator:a071000a2f5f77a40df8311fad5044481"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaef0c8a34738616876ae2397ba64ba86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#aaef0c8a34738616876ae2397ba64ba86">open</a> (std::string, unsigned int=115200, <a class="el" href="classserial_1_1_serial.html#a99b2dca0960526547c5a4a573237c615">flowControlType</a>=flowControlType::none, unsigned int=8, <a class="el" href="classserial_1_1_serial.html#a4ab9d6bc487d9f07907917d3b5e7c90f">parityType</a>=parityType::none, <a class="el" href="classserial_1_1_serial.html#ae41b45f62e5e46f53f650f2a2678b407">stopBitsType</a>=stopBitsType::one)</td></tr>
<tr class="separator:aaef0c8a34738616876ae2397ba64ba86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeab783cf03aca6b51640a871876ab04"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#adeab783cf03aca6b51640a871876ab04">isOpen</a> () const</td></tr>
<tr class="separator:adeab783cf03aca6b51640a871876ab04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501082725b61e4baf615266065bbac5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a501082725b61e4baf615266065bbac5f">close</a> ()</td></tr>
<tr class="separator:a501082725b61e4baf615266065bbac5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace8d009eb8a44748f0085f611b8b8fb5"><td class="memItemLeft" align="right" valign="top">std::future&lt; std::vector&lt; uint8_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#ace8d009eb8a44748f0085f611b8b8fb5">receive</a> ()</td></tr>
<tr class="separator:ace8d009eb8a44748f0085f611b8b8fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f135c34016f3dd2ebef5d8e3526685"><td class="memItemLeft" align="right" valign="top">std::future&lt; std::vector&lt; uint8_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a20f135c34016f3dd2ebef5d8e3526685">receive</a> (size_t const num_bytes)</td></tr>
<tr class="separator:a20f135c34016f3dd2ebef5d8e3526685"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76259c27ce0cdf1d4344ccf10e0a3686"><td class="memItemLeft" align="right" valign="top">std::future&lt; std::vector&lt; uint8_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classserial_1_1_serial.html#a76259c27ce0cdf1d4344ccf10e0a3686">receive</a> (size_t const num_bytes, unsigned int timeout)</td></tr>
<tr class="separator:a76259c27ce0cdf1d4344ccf10e0a3686"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="af7d30495c321c8ebc8d81278b2df2706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7d30495c321c8ebc8d81278b2df2706">&#9670;&nbsp;</a></span>errorCode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef boost::system::errc::errc_t <a class="el" href="classserial_1_1_serial.html#af7d30495c321c8ebc8d81278b2df2706">serial::Serial::errorCode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a99b2dca0960526547c5a4a573237c615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b2dca0960526547c5a4a573237c615">&#9670;&nbsp;</a></span>flowControlType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef boost::asio::serial_port_base::flow_control::type <a class="el" href="classserial_1_1_serial.html#a99b2dca0960526547c5a4a573237c615">serial::Serial::flowControlType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a4ab9d6bc487d9f07907917d3b5e7c90f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ab9d6bc487d9f07907917d3b5e7c90f">&#9670;&nbsp;</a></span>parityType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef boost::asio::serial_port_base::parity::type <a class="el" href="classserial_1_1_serial.html#a4ab9d6bc487d9f07907917d3b5e7c90f">serial::Serial::parityType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae41b45f62e5e46f53f650f2a2678b407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae41b45f62e5e46f53f650f2a2678b407">&#9670;&nbsp;</a></span>stopBitsType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef boost::asio::serial_port_base::stop_bits::type <a class="el" href="classserial_1_1_serial.html#ae41b45f62e5e46f53f650f2a2678b407">serial::Serial::stopBitsType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab4d8c523610ac8640b52a69b5287b93c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4d8c523610ac8640b52a69b5287b93c">&#9670;&nbsp;</a></span>Serial()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">serial::Serial::Serial </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a071000a2f5f77a40df8311fad5044481"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a071000a2f5f77a40df8311fad5044481">&#9670;&nbsp;</a></span>~Serial()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">serial::Serial::~Serial </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a501082725b61e4baf615266065bbac5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a501082725b61e4baf615266065bbac5f">&#9670;&nbsp;</a></span>close()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void serial::Serial::close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="adeab783cf03aca6b51640a871876ab04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeab783cf03aca6b51640a871876ab04">&#9670;&nbsp;</a></span>isOpen()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool serial::Serial::isOpen </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aaef0c8a34738616876ae2397ba64ba86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaef0c8a34738616876ae2397ba64ba86">&#9670;&nbsp;</a></span>open()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void serial::Serial::open </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>dev_node</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>baud</em> = <code>115200</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classserial_1_1_serial.html#a99b2dca0960526547c5a4a573237c615">flowControlType</a>&#160;</td>
          <td class="paramname"><em>flowControl</em> = <code>flowControlType::none</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>characterSize</em> = <code>8</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classserial_1_1_serial.html#a4ab9d6bc487d9f07907917d3b5e7c90f">parityType</a>&#160;</td>
          <td class="paramname"><em>parity</em> = <code>parityType::none</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classserial_1_1_serial.html#ae41b45f62e5e46f53f650f2a2678b407">stopBitsType</a>&#160;</td>
          <td class="paramname"><em>stopBits</em> = <code>stopBitsType::one</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ace8d009eb8a44748f0085f611b8b8fb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace8d009eb8a44748f0085f611b8b8fb5">&#9670;&nbsp;</a></span>receive() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::future&lt; std::vector&lt; uint8_t &gt; &gt; serial::Serial::receive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a20f135c34016f3dd2ebef5d8e3526685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f135c34016f3dd2ebef5d8e3526685">&#9670;&nbsp;</a></span>receive() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::future&lt; std::vector&lt; uint8_t &gt; &gt; serial::Serial::receive </td>
          <td>(</td>
          <td class="paramtype">size_t const&#160;</td>
          <td class="paramname"><em>num_bytes</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a76259c27ce0cdf1d4344ccf10e0a3686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76259c27ce0cdf1d4344ccf10e0a3686">&#9670;&nbsp;</a></span>receive() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::future&lt; std::vector&lt; uint8_t &gt; &gt; serial::Serial::receive </td>
          <td>(</td>
          <td class="paramtype">size_t const&#160;</td>
          <td class="paramname"><em>num_bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>timeout</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
